/*
 * Copyright (c) 2024 Alibaba Group Holding Ltd.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.alibaba.fluss.record;

import com.alibaba.fluss.annotation.PublicEvolving;

/**
 * Interface for accessing the records contained in a log. The log itself is represented as a
 * sequence of record batches (see {@link LogRecordBatch}).
 *
 * @since 0.1
 */
@PublicEvolving
public interface LogRecords {
    /**
     * The size of these records in bytes.
     *
     * @return The size in bytes of the records
     */
    int sizeInBytes();

    /**
     * Get the record batches. Note that the signature allows subclasses to return a more specific
     * batch type.
     *
     * @return An iterator over the record batches of the log
     */
    Iterable<LogRecordBatch> batches();
}
